FSIterateForks

FSIterateForks
Header:	Files.h		Carbon status:	Supported

Determines the name and size of every named fork belonging to a file or directory.

OSErr FSIterateForks (
    const FSRef *ref, 
    CatPositionRec *forkIterator, 
    HFSUniStr255 *forkName, 
    SInt64 *forkSize, 
    UInt64 *forkPhysicalSize
);

ref: A pointer to the file or directory containing the forks.
forkIterator: A pointer to a structure which maintains state between calls for a given FSRef. Before the first call, set the initialize field to 0. The forkIterator will be updated after the call completes; the updated iterator should be passed into the next call.
forkName: On return, a pointer to the name of the fork in Unicode. This parameter may be NULL.
forkSize: On return, a pointer to the logical size of the fork, in bytes. This parameter is optional; if you do not wish to retrieve this value, set the pointer to NULL.
forkPhysicalSize: On return, a pointer to the physical size of the fork (i.e. the amount of space allocated on disk) , in bytes. This parameter is optional; if you do not wish to retrieve this value, set the pointer to NULL.

function result: A result code.

DISCUSSION

Since information is returned about one fork at a time, several calls may be required to iterate through all the forks. There is no guarantee about the order in which forks are returned; the order may vary between iterations.

AVAILABILITY

Supported in Carbon. Available in Mac OS 9, and later when Carbon 1.0.2 or later is present.